home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / graphics / fracram.zip / FRACRAM.DOC < prev    next >
Text File  |  1995-01-30  |  10KB  |  260 lines
  1. FRAC-R.A.M. 
  2.  
  3. DOCUMENTATION
  4. =============
  5.  
  6.  
  7. INTRODUCTION:
  8. -------------
  9.     Frac-R.A.M. is a program designed to explore the world of fractals.  
  10. Included with the Frac-R.A.M. package are routines for the generation of 
  11. 10 different types of fractals and each type can be generated in either of
  12. two coloring methods.  These fractal types can be divided into two categories
  13. and are:
  14.     
  15. MANDELBROT TYPES
  16.     Type                    Method 1        Method 2
  17.     -------------------     ---------       ---------
  18.     Mandelbrot              (T-mndlm1)      (T-mndlm2)
  19.     Self Squared Dragon     (T-drgnm1)      (T-drgnm2)
  20.     Cosine                  (T-cosm1)       (T-cosm2)
  21.     Hyperbolic Cosine       (T-coshm1)      (T-coshm2)
  22.     Phoenix                 (T-phnxm1)      (T-phnxm2)
  23.  
  24. JULIAN TYPES
  25.     Type                    Method 1        Method 2
  26.     -------------------     --------        ---------
  27.     Mandelbrot              (T-mndlj1)      (T-mndlj2)
  28.     Self Squared Dragon     (T-drgnj1)      (T-drgnj2)
  29.     Cosine                  (T-cosj1)       (T-cosj2)
  30.     Hyperbolic Cosine       (T-coshj1)      (T-coshj2)
  31.     Phoenix                 (T-phnxj1)      (T-phnxj2)
  32.  
  33.     Users can also write their own routines for the generation of fractals 
  34. using the language of their choice (compiled languages only) and call them 
  35. from the Frac-R.A.M. program.
  36.  
  37.     Frac-R.A.M. also allows the use of different color palettes for the 
  38. generated fractals.  Included with the Frac-R.A.M. package are several 
  39. custom color palette files and the utility program "PALETTE".  The PALETTE 
  40. utility  allows the user to create their own custom color palettes.  
  41.  
  42.       1) Please refer to PALETTE.DOC for information on the PALETTE utility 
  43.      program.
  44.  
  45.       2) Please refer to USER.DOC for information on writing your own fractal 
  46.      generation routines.
  47.  
  48.  
  49. REQUIREMENTS:
  50. -------------
  51.     Frac-R.A.M. requires an EGA or compatible graphics card and monitor.  
  52. Upon start-up Frac-R.A.M. will test your computer to determine if your 
  53. graphics system is compatible.  If it is Frac-R.A.M. will start.  If it is 
  54. not Frac-R.A.M. will inform you that your graphics card is not the correct 
  55. type and will terminate.  
  56.  
  57.     Frac-R.A.M. also requires a mouse.  Upon start-up Frac-R.A.M. will test 
  58. your computer to determine if your computer has a mouse.  If it does Frac-
  59. R.A.M. will start.  If it does not Frac-R.A.M. will inform you that your 
  60. computer requires a mouse and will terminate.                            
  61.  
  62.  
  63. STARTING Frac-R.A.M:
  64. --------------------
  65.   To start Frac-R.A.M. type "FracRAM" at the DOS prompt and press <ENTER>.  
  66. Frac-R.A.M. will then load and start.  
  67.  
  68.  
  69. RUNNING Frac-R.A.M:
  70. -------------------
  71. The Frac-R.A.M. screen is divided into several windows.  The pattern below 
  72. depicts what each of the windows is used for:
  73.  
  74.    --------                                                     --------
  75.    | DATE |                                                     | TIME |
  76.    --------                                                     --------
  77.              ---------------------------------------------------
  78.              |                                                 |
  79.              |                                                 |
  80.              |                  FRACTAL DISPLAY                |
  81.              |                                                 |
  82.    --------          |                                                 |
  83.    | DATA |          |                                                 |
  84.    | VIEW |          |                                                 |
  85.    --------          ---------------------------------------------------
  86.  
  87.  
  88.   Frac-R.A.M. is completely mouse driven.  To select a command move the mouse 
  89. cursor (the pointing hand) to the desired command button and press the left
  90. mouse button.  The button that the mouse points to will appear to press. The 
  91. selected command will now be executed.  
  92.  
  93.   Some commands require a fractal to have been "Built" first.  If any of these 
  94. commands are selected before the building of a fractal the user will be 
  95. notified of the need to build a fractal first.
  96.  
  97.   Some commands require additional input.  When this is the case a pop-up 
  98. DIRECTORY window will appear.  The DIRECTORY window has four buttons and two 
  99. sub-windows.  The largest window is used to display the list of options.  The 
  100. small window displays the selected option. The buttons and their functions are 
  101. listed below:
  102.  
  103.     ENTER  - Records the selected option name and returns the 
  104.          player to the program.
  105.  
  106.     UP     - Scrolls the option list up.
  107.  
  108.     DOWN   - Scrolls the option list down.
  109.  
  110.     CANCEL - Cancels any selections made and returns the player 
  111.          to the program.
  112.  
  113.     MANUAL - To manually enter an option name move the mouse to 
  114.          the small window and press the left mouse button.
  115.          Once this has been done the small window will fill
  116.          with a dotted pattern and the name of the desired 
  117.          option can be entered manually.  To complete the
  118.          manual input press <ENTER>.
  119.  
  120.  
  121.   The main program buttons and their functions are listed below:
  122.  
  123.     LOAD -  The LOAD option scans the disk for all fractal 
  124.         ("*.FRC") files and displays a list of these files 
  125.         in the DIRECTORY window.  The user can then select 
  126.         a file to load.
  127.  
  128.     SAVE -  The SAVE option prompts the user for a name to 
  129.         save the fractal file under.  
  130.  
  131.     TYPE -  The TYPE option scans the disk for all executable 
  132.         ("?-??????.EXE") files and displays a list of these 
  133.         files in the DIRECTORY window.  
  134.  
  135.     MAKE -  The MAKE option writes all of the parameters (size, 
  136.         detail, and iteration limit) required for fractal 
  137.         generation to the file "FRACTAL.DAT".  The MAKE 
  138.         option then "shells" out to the fractal generation 
  139.         routine selected with the TYPE option.  The fractal 
  140.         generation routine then reads the parameters from 
  141.         the FRACTAL.DAT file and generates the fractal.
  142.  
  143.     COLOR - The COLOR option scans the disk for all palette 
  144.         ("*.PAL") files and displays a list of these files 
  145.         in the DIRECTORY window.
  146.  
  147.     SIZE -  The SIZE option produces and displays a list of 
  148.         size determination methods in the DIRECTORY window.
  149.         The size determination methods are:
  150.  
  151.         ZOOM-IN - Allows one to select the fractal 
  152.               size (horizontal and vertical start 
  153.               and stop values) graphically with the 
  154.               mouse.  To select a horizontal and 
  155.               vertical START value move the mouse 
  156.               cursor to a desired region of the 
  157.               fractal and press the left mouse button.  
  158.               Now to select a horizontal and vertical
  159.               STOP  value move the mouse cursor to a 
  160.               desired region of the fractal and again
  161.               press the left mouse button. 
  162.               NOTE: 1) As the mouse is moved about the 
  163.               current horizontal and vertical values 
  164.               are displayed in the "DATA VIEW" window;  
  165.               NOTE: 2) The area inside of the box is 
  166.               the actual area that will be generated.
  167.  
  168.         PIVOT --- Allows one to select the fractal 
  169.               pivot point (horizontal and vertical 
  170.               values) graphically with the mouse.  
  171.               To select a horizontal and vertical 
  172.               pivot value move the mouse cursor to 
  173.               a desired region of the fractal and 
  174.               press the left mouse button.  
  175.               NOTE: 1) As the mouse is moved about 
  176.               the current horizontal and vertical 
  177.               values are displayed in the "DATA VIEW" 
  178.               window.                       
  179.               NOTE: 2) The pivot value is only used 
  180.               for the generation of Julian types.
  181.  
  182.         QUERY --- Allows one to read the horizontal and 
  183.               vertical values anywhere on the fractal.
  184.               This is done graphically with the mouse.
  185.               As the mouse is moved about the current 
  186.               horizontal and vertical values are displayed 
  187.               in the "DATA VIEW" window.
  188.  
  189.         KEYBOARD -Allows the user to manually enter the axis
  190.               end points. These end points are:
  191.  
  192.               X_START - Horizontal (X axis) start value.
  193.  
  194.               X_STOP -- Horizontal (X axis) stop value.
  195.  
  196.               Y_START - Vertical (Y axis) start value.
  197.  
  198.               Y_STOP -- Vertical (Y axis) stop value.
  199.  
  200.               X_PIVOT - Horizontal (X axis) pivot value.
  201.               Please note that this parameter is only 
  202.               used for JULIAN type fractals.
  203.  
  204.               Y_PIVOT - Vertical (Y axis) pivot value.
  205.               Please note that this parameter is only 
  206.               used for JULIAN type fractals.
  207.  
  208.         ZOOM-OUT -Sets the horizontal and vertical axis limits 
  209.               to the maximum allowed by Frac-R.A.M. (+/- 5.0).
  210.  
  211.     EXPORT- The EXPORT option saves the current fractal (including  
  212.         the pallete) as a PCX formatted image. Additionally, a
  213.         text (.DAT) file containing the fractals parameters is   
  214.         also written to the disk. 
  215.  
  216.     DETAIL -The DETAIL option produces and displays a list 
  217.         of iteration limits in the DIRECTORY window.
  218.  
  219.     EXIT -  The EXIT option terminates Frac-R.A.M.
  220.  
  221.  
  222. HINTS and NOTES:
  223. ----------------
  224. HINTS
  225. 1) The lower the detail (iteration limit) the quicker the fractal will 
  226. generate (with the poorest quality also).  However, this is useful when one 
  227. wants to zoom into an area and does not care about fractal quality.
  228.  
  229. 2) For the best quality one should increase the detail as one zooms into 
  230. a fractal area.
  231.  
  232. 3) All of the fractal generation routines provided with this package allow the 
  233. user to terminate the fractal generation - simply press the "ESC" button and 
  234. when the routine finishes the current column it will terminate.  
  235.  
  236. NOTES
  237. 1) Copyright (C) Ronald Marsh, 1991, All rights reserved.
  238.  
  239. 2) In no event shall Ronald Marsh be liable for any loss of profit or any 
  240. other damages from the use of this program.
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.